/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | foam-extend: Open Source CFD
   \\    /   O peration     | Version:     4.1
    \\  /    A nd           | Web:         http://www.foam-extend.org
     \\/     M anipulation  | For copyright notice see file Copyright
-------------------------------------------------------------------------------
License
	This file is part of foam-extend.

	foam-extend is free software: you can redistribute it and/or modify it
	under the terms of the GNU General Public License as published by the
	Free Software Foundation, either version 3 of the License, or (at your
	option) any later version.

	foam-extend is distributed in the hope that it will be useful, but
	WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
	General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.

Class
	Foam::GaussSeidelSmoother

Description
	A lduMatrix::smoother for Gauss-Seidel

SourceFiles
	GaussSeidelSmoother.C

\*---------------------------------------------------------------------------*/

#ifndef GaussSeidelSmoother_H
#define GaussSeidelSmoother_H

#include "lduMatrix.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{


class GaussSeidelSmoother
:
	public lduSmoother
{

public:

	//- Runtime type information
	TypeName("GaussSeidel");


	// Constructors

		//- Construct from components
		GaussSeidelSmoother
		(
			const lduMatrix& matrix,
			const FieldField<Field, scalar>& coupleBouCoeffs,
			const FieldField<Field, scalar>& coupleIntCoeffs,
			const lduInterfaceFieldPtrsList& interfaces
		);


	// Member Functions

		//- Smooth for the given number of sweeps
		static void smooth
		(
			scalarField& x,
			const lduMatrix& matrix,
			const scalarField& b,
			const FieldField<Field, scalar>& coupleBouCoeffs,
			const lduInterfaceFieldPtrsList& interfaces,
			const direction cmpt,
			const label nSweeps
		);


		//- Smooth the solution for a given number of sweeps
		virtual void smooth
		(
			scalarField& x,
			const scalarField& b,
			const direction cmpt,
			const label nSweeps
		) const;
};


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //
